[Event Grid] Add Control Plane API Version 2025-04-01-preview by bbi2015 · Pull Request #33889 · Azure/azure-rest-api-specs

bbi2015 · 2025-04-11T08:30:03Z

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

New resource provider.
New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix OpenAPI spec quality issues in S360.
Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
Other, please clarify:
- edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

openapi-pipeline-app · 2025-04-11T08:30:08Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2025-04-11T08:30:08Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

github-actions · 2025-04-11T08:33:13Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
Swagger	Microsoft.EventGrid
JavaScript	@azure/arm-eventgrid
Java	com.azure.resourcemanager:azure-resourcemanager-eventgrid
C#	Azure.ResourceManager.EventGrid
Go	sdk/resourcemanager/eventgrid/armeventgrid

razvanbadea-msft · 2025-04-11T13:28:49Z

    "userAssignedIdentity": {

maybe reference the UserAssignedIdentity from common-types?

Refers to: specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2025-04-15-preview/EventGrid.json:17813 in 9c8cf22. [](commit_id = 9c8cf22, deletion_comment = False)

razvanbadea-msft · 2025-04-11T13:30:23Z

      "description": "Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.",

use the new name for AAD - Microsoft Entra Id in descriptions for clarity

Refers to: specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2025-04-15-preview/EventGrid.json:17842 in 9c8cf22. [](commit_id = 9c8cf22, deletion_comment = False)

razvanbadea-msft · 2025-04-11T13:30:55Z

      "type": "string"

you can add uri format for these properties

Refers to: specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2025-04-15-preview/EventGrid.json:17839 in 9c8cf22. [](commit_id = 9c8cf22, deletion_comment = False)

razvanbadea-msft · 2025-04-11T13:31:44Z

Fix the required checks which fails

bbi2015 · 2025-04-23T04:18:14Z

Thanks for your feedback. We have other properties in swagger which represent base URL and we been using type: string for them.
Example:
Line 11971 -- "endpointBaseUrl": { "description": "The base URL that represents the endpoint of the partner destination.", "type": "string" },
Line 14054 -- "endpointBaseUrl": { "description": "The base URL that represents the endpoint of the destination of an event subscription.", "type": "string", "readOnly": true },
and others.
for sake of consistency, we would like to keep this one the same way.

Thanks for your feedback. We have other properties in swagger which represent base URL and we been using type: string for them.
Example:
Line 11971 -- "endpointBaseUrl": { "description": "The base URL that represents the endpoint of the partner destination.", "type": "string" },
Line 14054 -- "endpointBaseUrl": { "description": "The base URL that represents the endpoint of the destination of an event subscription.", "type": "string", "readOnly": true },
and others.
for sake of consistency, we would like to keep this one the same way.

You can keep type: string and add format: uri to indicate it's a URI. Will you be able to apply this to all similar properties?

Hi @gary-x-li ,

I have updated and PR and added format: uri to all new properties. I had tried adding format: uri to old properties as well, but seems like this fails the Breaking Change Test [Breaking Change Link]. Hence for now we would like to keep the existing ones as it is and incorporated your suggestions in the newly added properties.

The same behavior has been observed when I have added "format": "arm-id" and x-ms-arm-id-details to limit to identity resource type.

specification/eventgrid/resource-manager/readme.ruby.md

a-hamad

LGTM

…tgrid

bbi2015 added 3 commits April 11, 2025 10:32

Add previous 2024-12-15-preview version files as baseline

5dcc4b8

Add 2025-04-15-preview API version files

d0fdede

Fix API version in response header of example files

9c8cf22

bbi2015 requested review from JoshLove-msft, jsquire, l0lawrence, lmazuel and tadelesh as code owners April 11, 2025 08:30

bbi2015 requested a review from a-hamad April 11, 2025 08:30

microsoft-github-policy-service bot added the Event Grid label Apr 11, 2025

github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Apr 11, 2025

azure-sdk mentioned this pull request Apr 11, 2025

[AutoPR sdk/resourcemanager/eventgrid/armeventgrid] [Event Grid] Add Control Plane API Version 2025-04-01-preview azure-sdk/azure-sdk-for-go#13998

Closed

AzureRestAPISpecReview added ARMReview new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Apr 11, 2025

bbi2015 added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Apr 11, 2025

razvanbadea-msft added the ARMChangesRequested label Apr 11, 2025

bbi2015 requested review from a team, annatisch, deyaaeldeen, joseharriaga, kristapratico, mabhard, minhanh-phan, mssfang and yangyuan as code owners April 22, 2025 16:23

bbi2015 requested review from allenjzhang and mario-guerra April 22, 2025 16:23

AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview and removed ARMChangesRequested labels Apr 22, 2025

openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 22, 2025

Resolving merge conflicts

738cde7

AzureRestAPISpecReview removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 22, 2025

Removing x-ms-arm-id-details from existing properties

3c5997d

AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview labels Apr 23, 2025

gary-x-li added the Approved-Suppression label Apr 23, 2025

Renaming API version from 2025-04-15-preview to 2025-04-01-preview

26cbd84

a-hamad requested changes May 1, 2025

View reviewed changes

specification/eventgrid/resource-manager/readme.ruby.md Outdated Show resolved Hide resolved

Fixing readme.ruby.md with current api version

5dceef0

a-hamad approved these changes May 1, 2025

View reviewed changes

Merge remote-tracking branch 'upstream/main' into users/adebnath/even…

a132c49

…tgrid

Kishp01 approved these changes May 22, 2025

View reviewed changes

Merge remote-tracking branch 'upstream/main' into users/adebnath/even…

47b004a

…tgrid

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Event Grid] Add Control Plane API Version 2025-04-01-preview#33889

[Event Grid] Add Control Plane API Version 2025-04-01-preview#33889
JoshLove-msft merged 19 commits intoAzure:mainfrom
bbi2015:users/adebnath/eventgrid

bbi2015 commented Apr 11, 2025

Uh oh!

openapi-pipeline-app bot commented Apr 11, 2025 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Apr 11, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Apr 11, 2025 •

edited

Loading

Uh oh!

razvanbadea-msft commented Apr 11, 2025

Uh oh!

razvanbadea-msft commented Apr 11, 2025

Uh oh!

razvanbadea-msft commented Apr 11, 2025

Uh oh!

razvanbadea-msft commented Apr 11, 2025

Uh oh!

bbi2015 commented Apr 23, 2025 •

edited

Loading

Uh oh!

Uh oh!

a-hamad left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

bbi2015 commented Apr 11, 2025

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

Uh oh!

openapi-pipeline-app bot commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app bot commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Check

Uh oh!

razvanbadea-msft commented Apr 11, 2025

Uh oh!

razvanbadea-msft commented Apr 11, 2025

Uh oh!

razvanbadea-msft commented Apr 11, 2025

Uh oh!

razvanbadea-msft commented Apr 11, 2025

Uh oh!

bbi2015 commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

a-hamad left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

openapi-pipeline-app bot commented Apr 11, 2025 •

edited

Loading

openapi-pipeline-app bot commented Apr 11, 2025 •

edited

Loading

github-actions bot commented Apr 11, 2025 •

edited

Loading

bbi2015 commented Apr 23, 2025 •

edited

Loading